fast-node-logger

An opinionated file logger with limited rotation policy options, base on pino.

this package provides:

• quick start with default configuration.
• an instance of pino logger.
• flexibility of pino with options and prettify the output.
• create log files in logs directory of root project directory.
• delete old log files.
• type safe with typescript.

Notice:

This is an opinionated package that limit the flexibility of awesome pino package. if you need full functionality please use original package.

Quick Start

import { createLogger } from "fast-node-logger";

const logger = await createLogger();
logger.info(`Logger is Ready!`);

VSCode extension

You can use the complimentary extension for VSCode writelog-snippets.

Customization

const options: Options = {
  logDir: "./my-logs",
  retentionTime: 604800, // for 7 days
};
await createLogger(options);

Documentations

Documentations website

use pino original options Pino Docs

import { createLogger, Options } from "fast-node-logger";

const options: Options = {
  level: "trace",
};

const logger = await createLogger(options);

CreateLogger(options)

returns an instance of pino

import { createLogger } from "fast-node-logger";

const logger = await createLogger();

logger.info(`Logger is Ready!`);

writeLog(message, {stdout: false})

a shortcut for logger.info(message) with ability to additionally print to console with second parameter {stdout: true}

import { writeLog, createLogger, Options } from "fast-node-logger";

await createLogger();

writeLog(`logger is created!`, { stdout: true, level: "trace" });

TODO:

• add recommended log rotation
• add ability to integrate with cloud log services (e.g. sentry)

Changelog

v3.0.4

24 October 2022

• pkg: updated 3871425
• doc: change log 3fc8015